Skip to main content

Webhook: ISSUE_EDITED

Обзор​

Webhook ISSUE_EDITED срабатывает, когда существующая проблема обновляется. Это позволяет системам или пользователям быть уведомленными о внесенных изменениях, обеспечивая возможность отслеживания обновлений и синхронизации данных при необходимости.

Цель​

Этот webhook предназначен для уведомления заинтересованных сторон или систем о модификациях в деталях проблемы, таких как изменения в названии, назначении или других атрибутах, что позволяет эффективно отслеживать и управлять процессами.

Формат запроса​

Webhook отправляется в виде HTTP POST запроса с следующим JSON-пейлоадом:

{
   "entityId": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
   "type": "ISSUE_EDITED",
   "createdAt": "2024-12-16T12:11:08.622Z",
   "data": {
      "operation": "UPDATE",
      "current": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue - New name",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      }
   },
   "id": 201
}

Ключевые свойства​

Верхний уровень​

  • entityId: Уникальный идентификатор обновленной проблемы.
  • type: Указывает тип webhook (ISSUE_EDITED).
  • createdAt: Временная метка срабатывания webhook в формате ISO 8601.
  • data: Содержит подробности об изменениях, внесенных в проблему.

Раздел данных​

Общие данные​

  • operation: Описание выполненной операции над проблемой (UPDATE в этом случае).

Данные текущей (обновленной) проблемы​

  • id: Уникальный идентификатор проблемы.
  • organizationId: Идентификатор организации, связанной с проблемой.
  • name: Обновленное название проблемы.
  • assigneeId: Идентификатор пользователя, которому сейчас назначена проблема.
  • locationId: Идентификатор местоположения, связанного с проблемой.
  • createdBy: Идентификатор пользователя, который первоначально создал проблему.

Предыдущие (оригинальные) данные​

  • id: Уникальный идентификатор проблемы (не меняется).
  • organizationId: Идентификатор организации до обновления (не изменяется).
  • name: Исходное название проблемы до обновления.
  • assigneeId: Идентификатор первоначального исполнителя до изменения (если применимо).
  • locationId: Местоположение, связанное с проблемой до изменения.
  • createdBy: Идентификатор первоначального создателя проблемы.

Пример ответа​

Пример пейлоада для webhook, представляющего обновленную проблему:

{
   "entityId": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
   "type": "ISSUE_EDITED",
   "createdAt": "2024-12-16T12:11:08.622Z",
   "data": {
      "operation": "UPDATE",
      "current": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue - New name",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      },
      "previous": {
         "id": "af5d2ec9-54fa-4235-92fa-0092d282d7df",
         "organizationId": "9864d894-699a-4a00-8d4c-ae181215d721",
         "name": "New issue",
         "assigneeId": "6ad1a95b-ea50-4e23-8495-ef82900ca98d",
         "locationId": "27b732ee-5921-475f-acd7-137fc4d5aa0f",
         "createdBy": "6ad1a95b-ea50-4e23-8495-ef82900ca98d"
      }
   }
}

Преимущества webhook ISSUE_EDITED​

  1. Повышенная отслеживаемость: Отслеживание изменений в деталях проблемы, что помогает поддерживать ясную историю.
  2. Обновления в реальном времени: Обеспечивает оперативное обновление внешних систем об изменениях в проблемах.
  3. Упрощенная координация: Помогает командам и заинтересованным сторонам быть в курсе всех внесенных изменений.

Этот webhook особенно полезен для поддержания консистентности данных между интегрированными системами.